doc: clarify use of timeout option in vm#23512
doc: clarify use of timeout option in vm#23512vdeturckheim wants to merge 1 commit intonodejs:masterfrom vdeturckheim:update_vm_doc
Conversation
targos
left a comment
There was a problem hiding this comment.
LGTM. Does it already throw in all cases if the value is not a positive integer?
|
@targos I believe so. I tested 0, 0.1, 10.1 and they all failled |
|
Maybe it is worth to replace the |
|
@vsemozhetbyt do you know if we use it somewhere else in the doc? From a js perspective, the argument is of type |
|
FWIW, we have it as a hint in Line 8 in b2d8ae0 And we use it in docs: https://github.com/nodejs/node/search?l=Markdown&q=%7Binteger%7D |
|
Make sense! I'll update :) Thanks for pointing it! |
This updates the documentation to clarify how to use `timeout` in the vm module.
|
I am not sure why CI considers the subsystem is missing 🤔 |
I saw this on other PRs as well. Probably something wrong with our |
|
Let's restart CI when #23739 (review) is merged then |
|
Landed in 278086a |
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: nodejs#23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesThis clarifies the use of the
timeoutoption in thevmmodule. This number always must be a strictly positive integer otherwise it results in aTypeError